/*
 *  Copyright 2005 Blandware (http://www.blandware.com)
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package com.blandware.atleap.webapp.action.questionnaire.question;

import com.blandware.atleap.common.QuestionnaireModuleConstants;
import com.blandware.atleap.model.core.ContentLocale;
import com.blandware.atleap.model.questionnaire.Question;
import com.blandware.atleap.model.questionnaire.Questionnaire;
import com.blandware.atleap.service.questionnaire.QuestionnaireManager;
import com.blandware.atleap.webapp.action.core.BaseAction;
import com.blandware.atleap.webapp.form.questionnaire.QuestionForm;
import com.blandware.atleap.webapp.util.core.LocaleUtil;
import com.blandware.atleap.webapp.util.core.WebappConstants;
import com.blandware.atleap.webapp.util.core.WebappUtil;
import com.blandware.atleap.webapp.util.questionnaire.QuestionnaireModuleWebConstants;
import org.apache.commons.validator.GenericValidator;
import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;
import org.apache.struts.action.ActionMessage;
import org.apache.struts.action.ActionMessages;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import java.util.Iterator;
import java.util.List;
import java.util.Map;

/**
 * <p>Prepares form bean to update question's data.
 * </p>
 * <p><a href="CallUpdateQuestionAction.java.html"><i>View source</i></a></p>
 *
 * @author Roman Puchkovskiy <a href="mailto:roman.puchkovskiy@blandware.com">
 *         &lt;roman.puchkovskiy@blandware.com&gt;</a>
 * @version $Revision: 1.4 $ $Date: 2008/04/29 17:51:54 $
 * @struts.action path="/questionnaire/question/callUpdate"
 * name="questionForm"
 * scope="request"
 * validate="false"
 * roles="questionnaire-question-update, questionnaire-question-view"
 * @struts.action-forward name="updateQuestion"
 * path=".questionnaire.question.update"
 * @struts.action-forward name="listQuestions"
 * path="/questionnaire/question/list.do"
 * redirect="true"
 * @struts.action-forward name="listQuestionnaires"
 * path="/questionnaire/questionnaire/list.do"
 * redirect="true"
 */
public final class CallUpdateQuestionAction extends BaseAction {
	/**
	 * @param mapping  The ActionMapping used to select this instance
	 * @param form     The optional ActionForm bean for this request (if any)
	 * @param request  The HTTP request we are proceeding
	 * @param response The HTTP response we are creating
	 * @return an ActionForward instance describing where and how
	 *         control should be forwarded, or null if response
	 *         has already been completed
	 */
	public ActionForward execute(ActionMapping mapping, ActionForm form,
	                             HttpServletRequest request, HttpServletResponse response) throws Exception {

        QuestionForm questionForm = (QuestionForm) form;
        HttpSession session = request.getSession();
        Long questionnaireId = null;
        if (!GenericValidator.isBlankOrNull(questionForm.getQuestionnaireId())) {
            questionnaireId = Long.valueOf(questionForm.getQuestionnaireId());
        } else {
            questionnaireId = (Long) session.getAttribute(QuestionnaireModuleWebConstants.QUESTIONNAIRE_ID_KEY);
        }
        if (questionnaireId == null) {
            if (log.isWarnEnabled()) {
                log.warn("Missing questionnaire ID. Returning to list...");
            }
            return mapping.findForward("listQuestionnaires");
        }
        questionForm.setQuestionnaireId(questionnaireId.toString());

		session.removeAttribute(QuestionnaireModuleWebConstants.QUESTION_SUBMITTED_ACTION_KEY);

		if ( isCancelled(request) ) {
			return mapping.findForward("listQuestions");
		}

		if ( !request.isUserInRole("questionnaire-question-update") ) {
			response.sendError(HttpServletResponse.SC_FORBIDDEN);
			return null;
		}

		Long questionId = null;
		if ( questionForm.getId() != null ) {
			questionId = Long.valueOf(questionForm.getId());
		} else if ( request.getAttribute(QuestionnaireModuleWebConstants.QUESTION_ID_KEY) != null ) {
			questionId = (Long) request.getAttribute(QuestionnaireModuleWebConstants.QUESTION_ID_KEY);
		} else if ( request.getSession().getAttribute(QuestionnaireModuleWebConstants.QUESTION_ID_KEY) != null ) {
			questionId = (Long) request.getSession().getAttribute(QuestionnaireModuleWebConstants.QUESTION_ID_KEY);
		} else {
			if ( log.isWarnEnabled() ) {
				log.warn("Missing question ID. Returning to list...");
			}
			return mapping.findForward("listQuestions");
		}

		String redirectUrl = request.getParameter("redirectUrl");
		if ( GenericValidator.isBlankOrNull(redirectUrl) ) {
			redirectUrl = (String) request.getAttribute(WebappConstants.REDIRECT_URL_KEY);
		}
		if ( !GenericValidator.isBlankOrNull(redirectUrl) ) {
			request.getSession().setAttribute(WebappConstants.REDIRECT_URL_KEY, redirectUrl);
		} else {
			request.getSession().removeAttribute(WebappConstants.REDIRECT_URL_KEY);
		}

		String localesMode = questionForm.getLocalesMode();
		if ( !"current".equalsIgnoreCase(localesMode) && !"all".equalsIgnoreCase(localesMode) ) {
			localesMode = "selected";
		}
		questionForm.setLocalesMode(localesMode);

		QuestionnaireManager questionnaireManager = (QuestionnaireManager) getBean(QuestionnaireModuleConstants.QUESTIONNAIRE_MANAGER_BEAN);
        Questionnaire questionnaire = questionnaireManager.retrieveQuestionnaire(questionnaireId);
		if ( questionnaire == null ) {
			// questionnaire not found. it might be deleted by someone else
			ActionMessages errors = new ActionMessages();
			errors.add("ownerNotFound", new ActionMessage("questionnaire.question.errors.ownerNotFound"));
			saveErrors(request, errors);
			return mapping.findForward("listQuestionnaires");
		}

        if (questionnaire.getFixed().booleanValue()) {
			// questionnaire is fixed, it cannot be edited
			ActionMessages errors = new ActionMessages();
			errors.add("questionnaireIsFixed", new ActionMessage("questionnaire.questionnaire.errors.fixed"));
			saveErrors(request, errors);
			return mapping.findForward("listQuestions");
        }

		Question question = questionnaireManager.retrieveQuestion(questionId);
		if ( question == null ) {
			// question not found. it might be deleted by someone else
			ActionMessages errors = new ActionMessages();
			errors.add("questionNotFound", new ActionMessage("questionnaire.question.errors.notFound"));
			saveErrors(request, errors);
			return mapping.findForward("listQuestions");
		}
		WebappUtil.copyProperties(questionForm, question, request);
		questionForm.setTitleMap(question.getTitle());

		List contentLocales = LocaleUtil.getInstance(servlet.getServletContext()).getEnabledLocales();

		request.getSession().setAttribute(WebappConstants.CONTENT_LOCALES_COLLECTION_KEY, contentLocales);

        if ("selected".equalsIgnoreCase(localesMode)) {
            // mark all locales as checked
            Map titleCheckedBoxes = questionForm.getTitleCheckedBoxes();
            for (Iterator i = contentLocales.iterator(); i.hasNext();) {
                ContentLocale contentLocale = (ContentLocale) i.next();
                titleCheckedBoxes.put(contentLocale.getIdentifier(), Boolean.TRUE);
            }

            // check 'check all' ckeckbox
            request.setAttribute(WebappConstants.SELECT_ALL_LOCALES_CHECKBOX_IS_CHECKED, Boolean.TRUE);
        }

        request.setAttribute("validationRegexes", QuestionnaireModuleWebConstants.VALIDATION_REGEXES);

		// save transaction token in request
		saveToken(request);
		return mapping.findForward("updateQuestion");
	}
}
